/**
 * The contents of this file are subject to the OpenMRS Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://license.openmrs.org
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
 * License for the specific language governing rights and limitations
 * under the License.
 *
 * Copyright (C) OpenMRS, LLC.  All Rights Reserved.
 */
package org.openmrs.module.ampathhousehold.dao;

import java.util.List;

import org.openmrs.module.ampathhousehold.model.Household;

/**
 * Contract for database operation on Household object
 */
public interface HouseholdDAO {
	
	/**
	 * Save one household object to the database
	 * 
	 * @param household household object to be saved
	 * @return saved household object
	 */
	public Household saveHousehold(Household household);
	
	/**
	 * Get one household record based on the household id
	 * 
	 * @param id the household id
	 * @return household that match the id
	 */
	public Household getHousehold(Integer id);
	
	/**
	 * Get all household records
	 * 
	 * @return all household record in the system
	 */
	public List<Household> getAllHouseholds();
	
	/**
	 * Get all household based on the household village
	 * 
	 * @param village the village where the household comes from
	 * @return list of household on the village
	 */
	public List<Household> getHouseholds(String village);
	
}
